GET Users?take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves users for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
take |
Number of users to retrieve. Default is all users |
integer |
None. |
skip |
Number of users to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the users before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of users.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of User |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "UserId": "e82eef66-d427-4d20-843c-c72192b95f3e", "UserName": "sample string 1", "FullName": "sample string 2", "PhoneNumber": "sample string 3", "Email": "sample string 4", "IsLockedOut": true, "IsApproved": true, "Role": { "Name": "sample string 1", "Description": "sample string 2" }, "CompanyId": "5684fe6a-a5a4-4170-a6ef-9bc5ea5d489b", "Teams": [ { "TeamId": "137125ef-5b8b-4a94-bc7f-5f516f969b1d", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "194d38af-fb70-4693-85f6-4281f772b62f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-02T05:15:33.7246534-07:00", "MeasurementValueNeededDate": "2024-05-02T05:15:33.7246534-07:00", "SourceSystemId": "sample string 3", "CompanyId": "27e0c4d4-1223-487d-90a5-ae49d5cbdcda", "CreateDate": "2024-05-02T05:15:33.7246534-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T05:15:33.7246534-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "194d38af-fb70-4693-85f6-4281f772b62f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-02T05:15:33.7246534-07:00", "MeasurementValueNeededDate": "2024-05-02T05:15:33.7246534-07:00", "SourceSystemId": "sample string 3", "CompanyId": "27e0c4d4-1223-487d-90a5-ae49d5cbdcda", "CreateDate": "2024-05-02T05:15:33.7246534-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T05:15:33.7246534-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "1d96cbf9-f1dd-4ed0-a975-a33bef1d457b", "CreateDate": "2024-05-02T05:15:33.7246534-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T05:15:33.7246534-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "137125ef-5b8b-4a94-bc7f-5f516f969b1d", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "194d38af-fb70-4693-85f6-4281f772b62f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-02T05:15:33.7246534-07:00", "MeasurementValueNeededDate": "2024-05-02T05:15:33.7246534-07:00", "SourceSystemId": "sample string 3", "CompanyId": "27e0c4d4-1223-487d-90a5-ae49d5cbdcda", "CreateDate": "2024-05-02T05:15:33.7246534-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T05:15:33.7246534-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "194d38af-fb70-4693-85f6-4281f772b62f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-02T05:15:33.7246534-07:00", "MeasurementValueNeededDate": "2024-05-02T05:15:33.7246534-07:00", "SourceSystemId": "sample string 3", "CompanyId": "27e0c4d4-1223-487d-90a5-ae49d5cbdcda", "CreateDate": "2024-05-02T05:15:33.7246534-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T05:15:33.7246534-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "1d96cbf9-f1dd-4ed0-a975-a33bef1d457b", "CreateDate": "2024-05-02T05:15:33.7246534-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T05:15:33.7246534-07:00", "LastModifiedUser": "sample string 6" } ] }, { "UserId": "e82eef66-d427-4d20-843c-c72192b95f3e", "UserName": "sample string 1", "FullName": "sample string 2", "PhoneNumber": "sample string 3", "Email": "sample string 4", "IsLockedOut": true, "IsApproved": true, "Role": { "Name": "sample string 1", "Description": "sample string 2" }, "CompanyId": "5684fe6a-a5a4-4170-a6ef-9bc5ea5d489b", "Teams": [ { "TeamId": "137125ef-5b8b-4a94-bc7f-5f516f969b1d", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "194d38af-fb70-4693-85f6-4281f772b62f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-02T05:15:33.7246534-07:00", "MeasurementValueNeededDate": "2024-05-02T05:15:33.7246534-07:00", "SourceSystemId": "sample string 3", "CompanyId": "27e0c4d4-1223-487d-90a5-ae49d5cbdcda", "CreateDate": "2024-05-02T05:15:33.7246534-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T05:15:33.7246534-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "194d38af-fb70-4693-85f6-4281f772b62f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-02T05:15:33.7246534-07:00", "MeasurementValueNeededDate": "2024-05-02T05:15:33.7246534-07:00", "SourceSystemId": "sample string 3", "CompanyId": "27e0c4d4-1223-487d-90a5-ae49d5cbdcda", "CreateDate": "2024-05-02T05:15:33.7246534-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T05:15:33.7246534-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "1d96cbf9-f1dd-4ed0-a975-a33bef1d457b", "CreateDate": "2024-05-02T05:15:33.7246534-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T05:15:33.7246534-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "137125ef-5b8b-4a94-bc7f-5f516f969b1d", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "194d38af-fb70-4693-85f6-4281f772b62f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-02T05:15:33.7246534-07:00", "MeasurementValueNeededDate": "2024-05-02T05:15:33.7246534-07:00", "SourceSystemId": "sample string 3", "CompanyId": "27e0c4d4-1223-487d-90a5-ae49d5cbdcda", "CreateDate": "2024-05-02T05:15:33.7246534-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T05:15:33.7246534-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "194d38af-fb70-4693-85f6-4281f772b62f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-02T05:15:33.7246534-07:00", "MeasurementValueNeededDate": "2024-05-02T05:15:33.7246534-07:00", "SourceSystemId": "sample string 3", "CompanyId": "27e0c4d4-1223-487d-90a5-ae49d5cbdcda", "CreateDate": "2024-05-02T05:15:33.7246534-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T05:15:33.7246534-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "1d96cbf9-f1dd-4ed0-a975-a33bef1d457b", "CreateDate": "2024-05-02T05:15:33.7246534-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T05:15:33.7246534-07:00", "LastModifiedUser": "sample string 6" } ] } ], "Total": 1, "Message": "sample string 1" }